Filter hook 'rest_{$this->taxonomy}_query'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into rest_{$this->taxonomy}_query
add_filter('rest_{$this->taxonomy}_query', 'my_custom_filter', 10, 2);

function my_custom_filter($prepared_args, $request) {
    // Your custom filtering logic here
    return $prepared_args;
}

Source Code Context

<?php
 338  		 * @link https://developer.wordpress.org/reference/functions/get_terms/
 339  		 *
 340  		 * @param array           $prepared_args Array of arguments for get_terms().
 341  		 * @param WP_REST_Request $request       The REST API request.
 342  		 */
 343  		$prepared_args = apply_filters( "rest_{$this->taxonomy}_query", $prepared_args, $request );
 344  
 345  		if ( ! empty( $prepared_args['post'] ) ) {
 346  			$query_result = wp_get_object_terms( $prepared_args['post'], $this->taxonomy, $prepared_args );
 347  
 348  			// Used when calling wp_count_terms() below.

PHP Documentation

<?php
/**
		 * Filters get_terms() arguments when querying terms via the REST API.
		 *
		 * The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
		 *
		 * Possible hook names include:
		 *
		 *  - `rest_category_query`
		 *  - `rest_post_tag_query`
		 *
		 * Enables adding extra arguments or setting defaults for a terms
		 * collection request.
		 *
		 * @since 4.7.0
		 *
		 * @link https://developer.wordpress.org/reference/functions/get_terms/
		 *
		 * @param array           $prepared_args Array of arguments for get_terms().
		 * @param WP_REST_Request $request       The REST API request.
		 */